home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 001a / msk311.zip / MSKERM.HLP < prev    next >
Text File  |  1991-11-22  |  53KB  |  1,276 lines

  1.                                 MS-DOS KERMIT
  2.  
  3.         FOR THE IBM PC FAMILY, COMPATIBLES, AND OTHER MS-DOS COMPUTERS
  4.  
  5.              Version 3.11, September 1991
  6.  
  7. This file contains a summary of the commands and features of MS-DOS Kermit
  8. 3.11.  For detailed information, tutorials, installation and cabling hints,
  9. troubleshooting procedures, examples, diagrams, tables, and advanced features,
  10. consult "Using MS-DOS Kermit", second edition, by Christine M. Gianone,
  11. published by Digital Press, Bedford, MA (1991), order number EY-H893E-DP,
  12. Digital Press ISBN 1-55558-082-3, Prentice Hall ISBN 0-13-952276-X.  The book
  13. includes a 5.25-inch MS-DOS Kermit 3.11 diskette.  To order, call (USA, toll
  14. free) 1-800-343-8321.  It is also available from Kermit Distribution at
  15. Columbia University and in software stores and computer bookstores.  A German
  16. language edition, "MS-DOS Kermit -- das universelle Kommunikationsprogramm",
  17. is published by Verlag Heinz Heise GmbH & Co KG, Hannover, Germany, translated
  18. by Gisbert W. Selke.
  19.  
  20.   TCP/IP users: Read the section at the end of this file and the TCP/IP
  21.   section in the "beware file" for information that was not available at
  22.   "Using MS-DOS Kermit" press time. 
  23.  
  24. TERMS AND CONDITIONS
  25.  
  26. MS-DOS Kermit 3.11 is a product of Kermit Distribution, Columbia University
  27. Center for Computing Activities.  The principal author of the program is
  28. Professor Joe R. Doupnik of Utah State University, with help from other
  29. volunteer programmers all over the world.  The software is copyright 1982, 1991
  30. by the Trustees of Columbia University in the City of New York, with portions
  31. of the source code also copyright by other institutions including Waterloo
  32. University (Ontario, Canada) and the (US) National Center for Supercomputing
  33. Applications (NCSA).
  34.  
  35. The MS-DOS Kermit software may be reproduced and shared without restriction
  36. except that it may not be licensed or sold for profit as a software product.
  37. Kermit software is written by volunteer programmers as a public service, and is
  38. furnished without warranty of any kind.  Neither Columbia University, nor the
  39. individual authors, nor Digital Equipment Corporation, nor Digital Press, nor
  40. any institution or individual that has contributed to the development and
  41. documentation warrant the software in any way.
  42.  
  43. CONTACT INFORMATION
  44.  
  45. Technical support: (USA) 212-854-5126, or use e-mail addresses below.
  46.  
  47. Kermit programs are available for hundreds of different kinds of computers on a
  48. variety of magnetic media.  For MS-DOS Kermit, there are also sets of diskettes
  49. containing source code, related utilities, collections of key settings files,
  50. technical documentation, etc.  For a catalog of Kermit software and
  51. publications, write to:
  52.  
  53.   Kermit Distribution, Dept INFO
  54.   Columbia University Center for Computing Activities
  55.   612 West 115th Street
  56.   New York, NY  10025  USA
  57.  
  58. Or call (212) 854-3703, or send e-mail to:
  59.  
  60.   Info-Kermit@watsun.cc.columbia.edu (Internet) or KERMIT@CUVMA (BITNET/EARN).
  61.  
  62. PROGRAM INSTALLATION
  63.  
  64. Easy.  For diskette-only systems, make a backup copy of the Kermit diskette,
  65. run Kermit from the backup copy.
  66.  
  67. For hard-disk systems, make a \KERMIT directory on your hard disk, copy the
  68. Kermit diskette files to it, and add the hard disk \KERMIT directory to your
  69. DOS PATH (modify the PATH= command in your AUTOEXEC.BAT file).
  70.  
  71. In both cases, edit the MSKERMIT.INI and DIALUP.TXT files to suit your needs.
  72. See "Using MS-DOS Kermit" for more detailed instructions.  Also read the
  73. KERMIT.BWR (or MSKERM.BWR) file for problem-solving hints.
  74.  
  75. DIALING AND THE DIALING DIRECTORY
  76.  
  77. MS-DOS Kermit does not have a built-in DIAL command, but if you installed
  78. Kermit from the distribution disk according to instructions, you'll be able to
  79. use the DIAL macro defined in Kermit's initialization file, MSKERMIT.INI.  DIAL
  80. uses two additional files: HAYES.SCR, a script program for dialing Hayes
  81. modems, and DIALUPS.TXT, your dialing directory.  If you do not have a Hayes or
  82. compatible modem, you can write a new script program for dialing, modelled
  83. after HAYES.SCR (see Chapter 14 of "Using MS-DOS Kermit), or else dial your
  84. modem "manually" in CONNECT mode.  To use a dialing directory, create a plain
  85. text file called DIALUPS.TXT.  The file contains one line per entry:
  86.  
  87.   name   number   speed    parity   comments
  88.  
  89. The "name" is the name you want to use for this entry in your DIAL commands.
  90. "number" is the telephone number; "speed" is the dialing speed in bits per
  91. second, "parity" is the parity to use (even, odd, mark, space, or none).  The
  92. name, number, speed, and parity are separated from each other by one or more
  93. spaces.  Any words after the parity are ignored, so you can use them for
  94. comments.  If trailing fields (speed, parity) are omitted, Kermit's current
  95. values are used (but then you can't have a comment).  If you want to tell
  96. Kermit explicitly to use its current value for speed or parity, use an equal
  97. sign (=).  Examples:
  98.  
  99.   sprintnet  7654321      2400   mark
  100.   oofanet    6543210      1200   odd    This entry has a comment.
  101.   tymnet     93,876-5432  2400   even   You can put punctuation in the phone #.
  102.   hometone   T5551212     1200   none   T in number forces tone dialing
  103.   homepulse  P5551212     1200   none   P in number forces pulse dialing
  104.   anyspeed   999-9999     =      none   Use current speed, whatever it is.
  105.   anyparity  888-8888     9600   =      Use current parity, whatever it is.
  106.   whocares   777-7777     =      =      Use current speed and parity.
  107.   defaults   987-6543
  108.  
  109. To use the dialing directory, just type DIAL followed by the name, spelled out
  110. in full (case doesn't matter), for example:
  111.  
  112.   MS-Kermit>dial tymnet
  113.  
  114. If you type a name or number that is not in the directory, Kermit dials exactly
  115. the characters you type, for example DIAL 5552370 dials the number 5552370.
  116. DIAL FRED (if FRED is not in the directory) tells Kermit to dial the letters
  117. FRED, which won't accomplish anything useful with most modems.
  118.  
  119. To view your dialing directory, type LIST.  To view particular entries in your
  120. dialing directory, type LIST XXX, where XXX is a sequence of characters that
  121. appears in the desired entries (usually the name).  In the LIST command, case
  122. is important because it uses the DOS FIND program to list the entries:
  123.  
  124.   MS-Kermit>list tymnet
  125.   tymnet     93,876-5432  2400   even   You can put punctuation in the phone #.
  126.  
  127. In your dialing directory, you can include spaces in the name or number by
  128. enclosing it in braces, as in these examples:
  129.  
  130.   {my computer}  555-4321            2400   none
  131.   your-computer  {9 1 800 555 1234}  1200   odd
  132.   {our computer} {212 701 0000}     19200   space
  133.  
  134. Now you can type commands like DIAL MY COMPUTER, DIAL OUR COMPUTER.
  135.  
  136. The DIAL command assumes your dialing directory is stored on your PC as
  137. C:\KERMIT\DIALUPS.TXT.  If you want to keep it someplace else or you need to
  138. use some other name, find the statement:
  139.  
  140.   define _dialfile C:\KERMIT\DIALUPS.TXT
  141.  
  142. in your MSKERMIT.INI file and change the filename as desired, for example:
  143.  
  144.   define _dialfile F:\LOCAL\NUMBERS.DAT
  145.  
  146. If you don't want to use a dialing directory, delete, rename, or hide the
  147. dialing directory file, or undefine the _dialfile variable:
  148.  
  149.   define _dialfile
  150.  
  151. If you want to use the directory sometimes but not others, define a separate
  152. macro for dialing without it:
  153.  
  154.   define call take \m(_modem).SCR
  155.  
  156. (where _modem is defined as your modem type, e.g. HAYES, and you have an
  157. appropriate dialing script file in your PATH, e.g. HAYES.SCR).
  158.  
  159. SUMMARY OF MS-DOS KERMIT COMMANDS
  160.  
  161. The commands listed are for the IBM PC, PS/2, and compatibles.  Other versions
  162. of MS-DOS Kermit (DEC Rainbow, NEC PC, Victor 9000, etc) lack certain commands
  163. and features described here, primarily those having to do with networking,
  164. terminal emulation, and character set translation.
  165.  
  166. Kermit commands consist of a sequence of "words" (verbs, nouns, numbers,
  167. filenames) separated by spaces and terminated by carriage return (Enter).
  168. Command description use this notation:
  169.  
  170.   <parameter>   - Replace this with an actual number, or filename, etc.
  171.   <number>      - Replace with an actual decimal number
  172.   <filename>    - A file specification, which may include disk & directory
  173.   <hh:mm:ss>    - Time of day in 24-hour notation, less than 12 hours from now
  174.   [<parameter>] - An optional field, which may be omitted
  175.   {A,B,C}       - Choose one of the items listed
  176.   [{A,B,C}]     - Optionally choose one of the items listed
  177.   = <value>     - Shows default value for a field
  178.  
  179. The following characters perform special functions in MS-DOS Kermit commands:
  180.  
  181.   Space      Separates command words ("fields").
  182.   TAB        (Ctrl-I) Like space
  183.   ESC        (Ctrl-[) Completes a keyword if possible.
  184.   Enter      (Ctrl-M, Carriage Return) Enters a command.
  185.   Formfeed   (Ctrl-L) Like Enter, but clears the screen first.
  186.   Linefeed   (Ctrl-J) Like Enter.
  187.   Backspace  (Ctrl-H, Del) Deletes rightmost character from the command.
  188.   Ctrl-W     Deletes rightmost word from the command.
  189.   Ctrl-U     Deletes the entire command.
  190.   Ctrl-C     Cancels the current command, even if you have already entered it.
  191.   ?          (Question Mark) Requests a menu for the current command field.
  192.   ;          (Semicolon) Introduces a trailing command (in command files only).
  193.   \          (Backslash) Introduces a "backslash code".
  194.   ,          (Comma) Separates commands in a macro definition.
  195.   { }        (Braces) used for grouping characters or words together.
  196.  
  197. Backslash codes are used to enter special characters into Kermit commands, and
  198. for other purposes too.  For example, if you want to use the OUTPUT command to
  199. send a Ctrl-C to the host, you can't put the Ctrl-C literally in the command,
  200. because typing Ctrl-C would cancel the command.  Instead, put a backslash
  201. followed by digits to denote the ASCII value of the Ctrl-C character (3):
  202. "output \3".  Similarly for Carriage Return: "output login myname\13".
  203.  
  204.   \123    (up to 3 decimal digits) - A decimal number or character value
  205.   \d123   (up to 3 decimal digits) - Same as 123
  206.   \o123   (up to 3 octal digits) - An octal (base 8) number or char value
  207.   \x123   (2 hexadecimal digits) - A hexadecimal (base 16) number or character
  208.   \{ }    For grouping, e.g. \{12}6 = Ctrl-L 6, not ~
  209.   \;      Include a semicolon in a TAKE-file command or macro definition.
  210.  
  211. Other backslash codes:
  212.  
  213.   \%       Introduce a Kermit variable, \%1, \%2, ..., \%a, \%b, ... \%z
  214.   \K       (or \k) Introduce a Kermit connect-mode verb like \Kexit
  215.   {\Kxxx}  A user-defined macro called xxx assigned to a key
  216.   \B       (or \b) Send a BREAK (OUTPUT command only)
  217.   \255     Shorthand for CRLF or LFCR   (INPUT command only)
  218.   \CD      Carrier Detect RS-232 signal (WAIT command only)
  219.   \DSR     Data Set Ready RS-232 signal (WAIT command only)
  220.   \CTS     Clear to Send RS-232 signal  (WAIT command only)
  221.   \v(name) A built-in variable like \v(date).
  222.   \m(name) A user-defined named variable
  223.   \$(name) A DOS environment variable.
  224.  
  225. * PROGRAM MANAGEMENT COMMANDS
  226.  
  227. EXIT or QUIT
  228.   Exit from MS-DOS Kermit.  Close all logs and files.  Leave serial port
  229.   and modem connections open.  Close most kinds of network connections.
  230.   Execute ON_EXIT macro if one is defined.
  231.  
  232. TAKE <filename>
  233.   Execute Kermit commands from the specified file instead of the keyboard.
  234.  
  235. PUSH
  236.   Go to DOS prompt.  Return to Kermit prompt by typing the DOS EXIT command.
  237.   Preserves connections, settings, etc.
  238.  
  239. RUN <DOS-command> [ <arguments> ]
  240.   Run a DOS program or execute a DOS command, e.g. RUN EDLIN AUTOEXEC.BAT.
  241.  
  242. ECHO <text>
  243.   Display the <text> on the screen.  For issuing messages from TAKE files or
  244.   macros.  The <text> can contain backslash codes, variables, etc.
  245.  
  246. SET PROMPT <text>
  247.   Change the program prompt from MS-Kermit> to the specified text, which can
  248.   contain backslash codes, variables, etc.
  249.  
  250. COMMENT <text>
  251.   For adding comments to a TAKE file.
  252.  
  253. <command> ; text
  254.   Commands in TAKE files can have trailing comments preceded by semicolon (;).
  255.  
  256. <text>-
  257. <text>
  258.   Commands in TAKE files or macro definitions can be continued with hyphens,
  259.   but not in a trailing comment.
  260.  
  261. * DOS ACCESS COMMANDS
  262.  
  263. CD [<path>]
  264.   Change Directory.  Like DOS CD, but a disk drive letter can be included. 
  265.  
  266. CLS
  267.   Clear the PC's screen.
  268.  
  269. DELETE <filespec>
  270.   Delete specified file(s).
  271.  
  272. DIRECTORY [<filespec>]
  273.   Like DOS DIR command.
  274.  
  275. TYPE <filename>
  276.   Like DOS TYPE command.
  277.  
  278. SPACE [<disk-letter>]
  279.   Show free space on current or specified disk.
  280.  
  281. SHOW MEMORY
  282.   Show free memory.
  283.  
  284. Others, such as MORE, COPY, RENAME, etc, are defined as macros in MSKERMIT.INI.
  285.  
  286. * COMMANDS FOR GETTING INFORMATION
  287.  
  288. HELP
  289.   Display a brief help message about MS-DOS Kermit.
  290.  
  291. SHOW <category>
  292.   Display current settings, definitions, statistics selectively
  293.   (type SHOW ? for a list of categories that can be shown).
  294.  
  295. STATUS
  296.   Show values of most SET parameters.
  297.  
  298. VERSION
  299.   Display the program version number.
  300.  
  301. * COMMANDS FOR SETTING COMMUNICATION PARAMETERS
  302.  
  303. SET COM1 <address> [ <irq> ]
  304.   Tell Kermit the hardware address of COM1, which must be a 8250 or compatible
  305.   UART, and, optionally, that its interrupt request line number is <irq>.  Also
  306.   SET COM2, SET COM3, SET COM4.  Used to configure Kermit for nonstandard
  307.   communication boards.  If IRQ not specified, Kermit tries 3 and 4 (standard
  308.   IRQs for communication ports).  USE WITH EXTREME CAUTION: specification of
  309.   incorrect address or IRQ number could harm your PC or files.
  310.  
  311. SET PORT {COM1, COM2, COM3, COM4} = COM1
  312.   Select a communication device (SET PORT ? for list of available devices,
  313.   see below for local area nets).  You can also say SET PORT 1, SET PORT 2,
  314.   etc.  Port must be real 8250 or 16550A UART, or device that perfectly
  315.   emulates them.  If it isn't, Kermit will use BIOS rather than direct
  316.   hardware control, and will issue a message to that effect.
  317.  
  318. SET PORT {BIOS1, BIOS2, BIOS3, BIOS4}
  319.   Use BIOS-level driver for COM1, COM2, COM3, or COM4, etc, rather than
  320.   Kermit's own built-in hardware driver.  Allows Kermit to be used with BIOS
  321.   itself, BIOS Int 14H interceptors (on LANs, for example), nonstandard
  322.   devices, etc.
  323.  
  324. SET PORT <other> - See section on Local Area Networks.
  325.  
  326. SET SPEED <number>
  327.   Communications port line speed: 1200, 2400, 9600, etc.  SET SPEED ? for list.
  328.   75/1200 is "split speed" (75 out, 1200 in).  Applies to currently selected
  329.   serial port (COM1-COM4), or to EBIOS connections.  Ignored for other SET
  330.   PORT options.
  331.  
  332. SET PARITY {EVEN, ODD, MARK, SPACE, NONE} = NONE
  333.   Character parity to use during communication.  If terminal emulation works
  334.   but file transfer does not, SET PARITY to EVEN or SPACE or MARK.
  335.  
  336. SET DISPLAY { 7, 8 } = 7
  337.   Synonym for SET TERMINAL BYTESIZE { 7, 8 }
  338.  
  339. SET DUPLEX {FULL, HALF} = FULL
  340.   Select full or half duplex communication.
  341.   FULL = remote echo.  HALF = local echo plus RTS/CTS hardware handshake.
  342.  
  343. SET HANDSHAKE {NONE, XON, CR, LF, CODE <ascii-value>} = NONE
  344.   Half-duplex line turnaround character (XON is most common), mostly for
  345.   use with IBM mainframes.  Only affects file transfer.
  346.  
  347. SET FLOW-CONTROL {XON/XOFF, RTS/CTS, NONE} = XON/XOFF
  348.   Select a full-duplex flow control method.
  349.  
  350. * COMMANDS FOR CONNECTING TO A REMOTE HOST
  351.  
  352. CONNECT
  353.   Make a terminal connection to a device or another computer on the currently
  354.   selected port using the current communication settings.  Use Alt-X to return
  355.   ("escape back") to the MS-Kermit> prompt (hold down the Alt key and press x)
  356.   or Ctrl-] followed by C.  You can abbreviate CONNECT as C.
  357.  
  358. HANGUP
  359.   Hang up a dialed modem connection by lowering DTR for about 1/2 second, or
  360.   close a network connection.
  361.  
  362. SET DEBUG SESSION
  363.   Turn off the terminal emulator, display received characters literally for
  364.   debugging: ^X = Ctrl-X, ~X = X with 8th bit on.
  365.  
  366. SET DEBUG OFF
  367.   Turn off session debugging, restore normal terminal emulation.
  368.  
  369. * COMMANDS FOR CONTROLLING TERMINAL EMULATION
  370.  
  371. SET TERMINAL [ TYPE ] { VT320, VT220, VT100, VT102, VT52, HEATH-19, 
  372.     HONEYWELL, TEK4010, NONE } = VT320
  373.   Select type of terminal to emulate.  Other types may be available, type
  374.   SET TERMINAL TYPE ? for a list.
  375.  
  376. SET TERMINAL ARROW-KEYS { APPLICATION, CURSOR }
  377.   Puts the arrow keys in the specified mode.
  378.  
  379. SET TERMINAL BELL { AUDIBLE, VISUAL, NONE } = AUDIBLE.
  380.   What to do with arriving BEL (beep, Ctrl-G) characters.
  381.  
  382. SET TERMINAL BYTESIZE { 7, 8 } = 7
  383.   Use 7 for stripping off parity bit, e.g. with UNIX systems, during terminal
  384.   emulation.  Use 8 for 8-bit international character sets, and for properly
  385.   receiving 8-bit control characters, such as sent by VAX/VMS applications
  386.   like EVE.
  387.  
  388. SET TERMINAL CHARACTER-SET { LATIN1, DEC-MCS, GERMAN, FRENCH, etc } = LATIN1
  389.   Character set used by the host computer during terminal emulation.  Optional
  390.   trailing parameters G0, G1, G2, and G3 can be used to designate the character
  391.   set to the given Gn tables.  Example: SET TERM CHAR LATIN1 G1.
  392.  
  393. SET TERMINAL CLEAR-SCREEN
  394.   Clear the terminal screen.
  395.  
  396. SET TERMINAL COLOR <number> [, <number> [, <number> ] ]
  397.   Set fore- and background color for text terminal emulation.  The numbers are
  398.   0 (normal foreground), 1 (high-intensity foreground), 10 (fast screen update
  399.   on IBM EGA), 3x (foreground color), 4x (background color), where x is the sum
  400.   of any of 1 (Red), 2 (Green), and 4 (Blue).
  401.  
  402. SET TERMINAL CONTROLS {7-BIT, 8-BIT}
  403.   Tell VT220/320 emulator whether to send 7-bit or 8-bit control sequences when
  404.   DEC function, arrow, editing, or keypad keys are pressed.
  405.  
  406. SET TERMINAL CURSOR-STYLE {BLOCK, UNDERLINE}
  407.   Select the cursor style for terminal emulation.  The default is underline.
  408.  
  409. SET TERMINAL DIRECTION {LEFT-TO-RIGHT, RIGHT-TO-LEFT}
  410.   Direction of screen writing during terminal emulation.
  411.  
  412. SET TERMINAL DISPLAY
  413.   Synonym for SET TERMINAL BYTESIZE.
  414.  
  415. SET TERMINAL GRAPHICS <name>
  416.   Specify the type of graphics adapter in your PC: CGA, EGA, VGA, others (SET
  417.   TERM GRAPH ? for complete list).  MS-DOS Kermit automatically tries to figure
  418.   out what kind of adapter you have.  Use this command if it guesses wrong.
  419.   Applies to Tektronix emulation only.
  420.  
  421. SET TERMINAL GRAPHICS CHARACTER-WRITING {OPAQUE, TRANSPARENT}
  422.   Tell whether text characters written on graphics screens should let graphics
  423.   show through.
  424.  
  425. SET TERMINAL GRAPHICS COLOR <number> [, <number> [, <number> ] ]
  426.   Fore- and background colors for graphics screens.  Numbers same as for
  427.   SET TERMINAL COLOR.
  428.  
  429. SET TERMINAL GRAPHICS CURSOR {ON, OFF}
  430.   Tell whether there should be a text cursor during graphics terminal
  431.   emulation.  Default is ON.
  432.  
  433. SET TERMINAL KEYCLICK {ON, OFF}
  434.   Turn keyclick on or off on keyboards that support this.
  435.  
  436. SET TERMINAL KEYPAD {APPLICATION, NUMERIC}
  437.   Put the numeric keypad into the specified mode.
  438.  
  439. SET TERMINAL MARGIN-BELL {ON, OFF}
  440.   Whether to ring the bell when the cursor nears the end of a screen line.
  441.  
  442. SET TERMINAL NEWLINE {ON, OFF}
  443.   ON means to send both a carriage return and a linefeed when you press Enter.
  444.   OFF means send only carriage return.
  445.  
  446. SET TERMINAL REPLAY
  447.   Synonym for REPLAY.
  448.  
  449. SET TERMINAL ROLLBACK {ON, OFF}
  450.   ON means to restore rolled-back screens to the end when new characters
  451.   arrive.  OFF means to display new characters at the current cursor position.
  452.  
  453. SET TERMINAL SCREEN-BACKGROUND {NORMAL, REVERSE}
  454.   REVERSE exchanges the fore- and background screen colors.
  455.  
  456. SET TERMINAL TABSTOPS {AT <n>, CLEAR AT <n>, CLEAR ALL}
  457.   Sets or clears screen tab stops at the specified positions.  <n> can be a
  458.   single number, a list of numbers, or <position>:<interval> to set tabs
  459.   beginning at the specified <position>, every <interval> spaces, e.g.
  460.   SET TAB AT 1:10.  By default, tabs are set every eight spaces.
  461.  
  462. SET TERMINAL TEK {ENABLE, DISABLE}
  463.   Whether Kermit should automatically enter Tektronix graphics mode upon
  464.   receipt of special escape sequences from the host.  ENABLEd by default.
  465.  
  466. SET TERMINAL UPSS {DEC-MCS, LATIN1}
  467.   Select which character set to designate as your VT220/VT320 User Preferred
  468.   Supplemental Set.
  469.  
  470. SET TERMINAL WIDTH {80, 132}
  471.   Put the video adapter into 80- or 132-column mode.  If Kermit can do this
  472.   itself, it will.  Otherwise it will attempt to run the DOS batch program
  473.   COLS80.BAT or COLS132.BAT to do the job.  You must supply these files.  They
  474.   should contain whatever external DOS commands you have at your disposal to
  475.   change the screen width.
  476.  
  477. SET TERMINAL WRAP {ON, OFF}
  478.   Whether to break overlong screen lines into multiple lines.
  479.  
  480. SET PRINTER <name>
  481.   Redirect any printing that is done during terminal emulation to a device
  482.   or file.  Default is PRN (the DOS printer device).
  483.  
  484. * LOCAL AREA NETWORKS
  485.  
  486. The SET PORT command tells Kermit which type of network connection you want to
  487. use, and in some cases also the network host you want to communicate with.
  488.  
  489. SET PORT TCP/IP [ <internet-name or internet-address> ]
  490.   Connect to an TCP/IP host using Kermit's built-in TCP/IP support.  If the
  491.   host is omitted, the one used in the most recent SET PORT TCP/IP or SET
  492.   TCP/IP HOST command is used, if any (this allows you to switch to another
  493.   type of connection and then back to your TCP/IP connection).  During a TCP/IP
  494.   session, Kermit uses TELNET protocol to communicate with the TELNET server on
  495.   the remote host.  See TCP/IP Network section below.
  496.  
  497. SET PORT NETBIOS
  498.   Tell Kermit to use IBM Netbios rather than a serial communication port.
  499.   Kermit awaits connections from other PCs on the net.  Also used with AT&T
  500.   StarLAN/StarGROUP.
  501.  
  502. SET PORT NETBIOS <name>
  503.   Tell Kermit to connect to another PC on the Netbios network.  Also for
  504.   AT&T StarLAN/StarGroup hosts.
  505.  
  506. SET NETBIOS-NAME <name>
  507.   Tell Kermit to set your PC's Netbios node name to <name>.  Kermit
  508.   appends ".K" to the end of the name if you don't include it yourself.
  509.  
  510. SET PORT NOVELL
  511.   For using Novell network asynchronous communication servers (NASI/NACS).
  512.  
  513. SET PORT DECNET [<node> [<password>]]
  514.   For DECnet-DOS LAT or CTERM connections.  Specify node to connect to, LAT
  515.   password if required.
  516.  
  517. SET PORT UB-NET1
  518.   For Ungermann-Bass Net/One.
  519.  
  520. SET PORT OPENNET [<node>]
  521.   For Intel OpenNET, similar to Netbios.
  522.  
  523. SET PORT 3COM
  524.   For using 3COM BAPI asynchronous communication server, BRIDGE PCS or 3+OPEN
  525.   TCP versions.
  526.  
  527. SET PORT EBIOS { 1, 2, 3, 4 } [ name-of-server-port ]
  528.   Use Extended BIOS for communication with EBIOS-based asynchronous
  529.   communication servers like IBM's LANACS.
  530.  
  531. SET PORT TELAPI <internet-address>
  532.   Connect to an Internet TCP/IP host through Novell LAN Workplace for DOS.
  533.  
  534. SET PORT TES <hostname>
  535.   Connect to a VAX/VMS system that is running Netware/VMS.
  536.  
  537. SET PORT { BIOS1, BIOS2, BIOS3, BIOS4 }
  538.   For using any network that operates through a BIOS Int 14h COM port driver.
  539.  
  540. HANGUP
  541.   Close network connection, terminate network session.
  542.  
  543. * CONNECT-MODE ESCAPE-LEVEL COMMANDS
  544.  
  545. During terminal emulation, you may type Ctrl-] (hold down Ctrl and press the
  546. rightbracket key) followed by any of the following characters (on German
  547. keyboards, hold down Strg and press +):
  548.  
  549.   ?   Help -- prints the available escape-level commands
  550.   0   (the digit zero) Transmit a NUL (ASCII 0)
  551.   B   (also Alt-B) Transmit a BREAK signal 
  552.   C   (also Alt-X) Return to Kermit prompt level, keep connection open 
  553.   F   (also Ctrl-End) File the current text screen in the screen dump file 
  554.   H   Hangup the phone or network connection
  555.   L   Transmit a Long Break (1.8 seconds)
  556.   M   Toggle the mode line, i.e. turn it off if it is on & vice versa
  557.   P   Push to DOS; get back to CONNECT by typing EXIT at the DOS prompt
  558.   Q   Temporarily quit logging the remote session
  559.   R   Resume logging the remote session
  560.   S   (also Alt-S) Show the status of the connection 
  561.   ^]  (or whatever you have set the escape character to be)
  562.       Typing the escape character twice sends one copy of it to the host
  563.  
  564. * SET TRANSLATE INPUT COMMAND
  565.  
  566.   SET TRANSLATE ON
  567.   SET TRANSLATE INPUT <code1> <code2>
  568.  
  569. Specify that when a character that would normally be translated to <code1>
  570. arrives at the communication port during terminal emulation, it should be
  571. translated into <code2> before display on the screen.  Overrides current
  572. terminal character set translation for that character.  Translations set up in
  573. this way take effect only after you give the command SET TRANSLATE INPUT ON.
  574.  
  575. * SET KEY COMMAND
  576.  
  577.   SET KEY <scancode> <value>
  578.  
  579. Assign <value> to the key whose scan code is given.  When you press the key
  580. or key combination that corresponds to the scan code during terminal
  581. emulation, the <value> is transmitted out the communication port.  If you
  582. don't know the scan code, type SET KEY alone on a line, then press the desired
  583. key or key combination when prompted, then enter the definition.  The <value>
  584. can be a single character, a text string (which may contain backslash codes),
  585. or one or more Kermit verbs.
  586.  
  587. * COMMONLY USED KERMIT KEYBOARD VERBS
  588.  
  589. The default key assignment is in parentheses.
  590.  
  591.   \Kexit        Exit from connect mode (Alt-X, Ctrl-]C)
  592.   \Kbreak       Send a BREAK signal (Alt-B, Ctrl-]B)
  593.   \Kdos         Push to DOS (Ctrl-]P)
  594.   \Kdump        Dump current screen to file (Ctrl-End)
  595.   \Khangup      Hangup communication port connection (Ctrl-]H)
  596.   \Klogoff      Stop session logging (Ctrl-]Q)
  597.   \Klogon       Resume session logging (Ctrl-]R)
  598.   \Knethold     Put network connection on hold or enter network shell (Alt-n)
  599.   \Kmodeline    Toggle mode line off/on++ (keypad minus)
  600.   \Kprtscn      Print current screen (Print Screen)
  601.   \Kreset       Reset terminal emulator (Alt-=)
  602.   \Ktermtype    Switch between text and graphics screens (Alt-minus)
  603.   \Kupscn       Roll back screen (PgUp)
  604.   \Kupone       Roll back screen one line (Ctrl-PgUp)
  605.   \Kdnscn       Roll screen forward (PgDn)
  606.   \Kdnscn       Roll screen forward one line (Ctrl-PgDn)
  607.   \KterminalR   Execute macro named TERMINALR if any
  608.   \KterminalS   Execute macro named TERMINALS if any
  609.   {\Kxxxx}      Execute macro named xxxx (xxxx can be any name)
  610.  
  611. Use SET KEY to assign or reassign these verbs to the keys of your choice.
  612. Example: "SET KEY \315 \Kexit" puts \Kexit on the F1 key.
  613.  
  614.   SET KEY CLEAR: Restore all Kermit's default key assignments.
  615.   SET KEY ON:    Use BIOS to read keystrokes (scan codes).
  616.   SET KEY OFF:   Use DOS rather than BIOS to read keystrokes.
  617.   SET KEY LK:    Use external DEC LK250 keyboard driver (if loaded).
  618.  
  619. * PRINTER CONTROL
  620.  
  621. During terminal emulation, Kermit controls the printer according to escape
  622. sequences received from the host, including the following for
  623. VT102/220/320 emulation:
  624.  
  625.   ESC [ 5 i    Begin transparent print (send port characters to printer)
  626.   ESC [ 4 i    End transparent print
  627.   ESC [ ? 5 i  Begin autoprint (send screen lines to printer)
  628.   ESC [ ? 4 i  End autoprint
  629.  
  630. Kermit also lets you use Ctrl-Print Screen to turn the printer on and off
  631. during terminal emulation.  The following command affects all these operations:
  632.  
  633. SET PRINTER <filename, PRN, or NUL>
  634.   Sends Connect mode printer material to the indicated file instead of to the
  635.   standard DOS printer name PRN; this is a "print to disk" option.  SHOW LOG
  636.   displays the current filename (defaults to PRN).
  637.  
  638. If you press Print Screen (no Ctrl), DOS gets the request itself, Kermit never
  639. sees it so the SET PRINTER command does not affect Print Screen.
  640.  
  641. * COMMANDS FOR TRANSFERRING FILES
  642.  
  643. Start a Kermit program on the remote computer, give it a "send", "receive",
  644. or "server" command, escape back to MS-DOS Kermit, and give it one of the
  645. following commands:
  646.  
  647. SEND <filename> [<alternate-name>]
  648.   Send files to remote Kermit receiver or server.  Can abbreviate as S.
  649.  
  650. RECEIVE [<filename>]
  651.   Wait for a file to arrive from the other Kermit program, which must
  652.   be given a SEND command.  Can abbreviate as R.
  653.  
  654. GET <remote-filename>
  655.   Ask a Kermit server to send the specified file(s).  Use GET <Enter>
  656.   to be prompted for remote and local names separately.
  657.  
  658. MAIL <filespec> <address>
  659.   Send the file as electronic mail to the address (if the remote Kermit
  660.   supports this feature).
  661.  
  662. * GETTING INFORMATION ABOUT FILE TRANSFER
  663.  
  664. SHOW STATISTICS
  665.   Display efficiency and other statistics about file transfers.
  666.  
  667. SHOW PROTOCOL
  668.   Display file transfer protocol-related parameter settings.
  669.  
  670. SHOW FILE
  671.   Display file-related parameter settings
  672.  
  673. * COMMANDS FOR TALKING TO A SERVER
  674.  
  675. BYE
  676.   Shut down a remote Kermit server and log out its job
  677.  
  678. FINISH
  679.   Shut down a remote Kermit server, put it back at command level
  680.  
  681. GET <remote-filename>
  682.   Ask a Kermit server to send the specified file(s)
  683.  
  684. SEND <filename> [<alternate-name>]
  685.   Send files to remote Kermit receiver or server
  686.  
  687. REMOTE CD [<directory> [<password>]]
  688.   Tell remote server to change to named directory.
  689.  
  690. REMOTE DELETE <filespec>
  691.   Tell remote server to delete the specified files.
  692.  
  693. REMOTE DIRECTORY [<filespec>]
  694.   Tell remote server to send directory listing for specified files.
  695.  
  696. REMOTE HELP
  697.   Ask the server to list the services it provides
  698.  
  699. REMOTE HOST command
  700.   Command for remote host in its own command language
  701.  
  702. REMOTE KERMIT command
  703.   Send a command to remote Kermit server in its own command language
  704.  
  705. REMOTE LOGIN user
  706.   Login to a remote Kermit server, separate prompts for password, etc.
  707.  
  708. REMOTE MESSAGE text
  709.   Send a one-line message to the remote Kermit server
  710.  
  711. REMOTE PRINT <filespec> [ <options> ]
  712.   Send the file to a remote server and ask the server to print it with the
  713.   specified options, if any.
  714.  
  715. REMOTE SET <parameter> <value>
  716.   Tell remote server to set the specified parameter to the specified value.
  717.  
  718. REMOTE SPACE [directory]
  719.   Show disk space on remote host
  720.  
  721. REMOTE TYPE filespec
  722.   Display remote file(s)
  723.  
  724. REMOTE WHO
  725.   Display users logged on remote system
  726.  
  727. * COMMANDS FOR ACTING AS A SERVER
  728.  
  729. DISABLE <parameter>
  730.   Disable various capabilities of the server (DISABLE ? for list)
  731.  
  732. ENABLE <parameter>
  733.   Enable various capabilities of the server (ENABLE ? for list)
  734.  
  735. SET SERVER TIMEOUT <num>
  736.   How often the server should send NAK packets while waiting for a command,
  737.   0 = never (default).
  738.  
  739. SET SERVER LOGIN <name> <password>
  740.   Set up a name and password which must be sent to the server (by REMOTE
  741.   LOGIN) before it will accept any other commands.
  742.  
  743. SHOW SERVER
  744.   Examine server-related parameters.
  745.  
  746. SERVER [{<seconds>, <hh:mm:ss>}]
  747.   Act as a Kermit server, optionally for or until the given time.  Default time
  748.   is forever (until BYE or FINISH received, or interrupted with Ctrl-C).
  749.  
  750. The MS-DOS Kermit server honors the following requests:
  751.  
  752.   SEND        REMOTE CWD        REMOTE PRINT
  753.   GET         REMOTE DELETE     REMOTE MESSAGE
  754.   FINISH      REMOTE DIRECTORY  REMOTE SPACE
  755.   BYE         REMOTE HOST       REMOTE TYPE
  756.   LOGOUT      REMOTE KERMIT     REMOTE SET
  757.  
  758. * INTERRUPTION COMMANDS WHILE A FILE TRANSFER IS IN PROGRESS
  759.  
  760.   X or Ctrl-X: Stop sending the current file and go on to the next one, if any.
  761.   Z or Ctrl-Z: Stop sending this file, and don't send any further files.
  762.   E or Ctrl-E: Send Error packet to the remote Kermit.
  763.   C or Ctrl-C: Return to Kermit command level immediately.
  764.   Q or Ctrl-Q: Send a Ctrl-Q (Xon).
  765.   Enter key:   Try to wake up a stuck file transfer.
  766.  
  767. * CHANGING FILE TRANSFER PARAMETERS
  768.  
  769. SET ATTRIBUTES { ON, OFF } = ON
  770.   Enable/Disable processing of file attribute packets.
  771.  
  772. SET ATTRIBUTES { DATE, LENGTH, TYPE, CHARACTER-SET } { ON, OFF } = ON
  773.   Enable/Disable processing of specific file attributes.
  774.  
  775. SET BLOCK-CHECK { 1, 2, 3 } = 1
  776.   Level of error checking, 1 by default, 3 is strongest.
  777.  
  778. SET DEBUG PACKETS
  779.   Display packets on screen during file transfer.
  780.  
  781. SET DEBUG OFF
  782.   Turn off display of packets.
  783.  
  784. SET DESTINATION { DISK, PRINTER, SCREEN } = DISK
  785.   Direct incoming files to the specified device.
  786.  
  787. SET FILE DISPLAY { SERIAL, REGULAR, QUIET } = REGULAR
  788.   Format of Kermit's file transfer display.  Use SERIAL for hardcopy terminals,
  789.   Braille devices, speaking devices, etc.  QUIET means no display at all (used
  790.   automatically in remote mode).  Synonym: SET DISPLAY.
  791.  
  792. SET EOF { CTRL-Z, NOCTRL-Z } = NOCTRL-Z
  793.   Whether Ctrl-Z marks the end of a PC DOS text file.
  794.  
  795. SET FILE TYPE { TEXT, BINARY } = TEXT
  796.   TEXT implies record format conversion and character set translation.  Use
  797.   BINARY to send or receive files with no conversaion at all.
  798.  
  799. SET FILE COLLISION { DISCARD, OVERWRITE, RENAME }
  800.   What to do when a file arrives that has the same name as an existing file:
  801.     RENAME   = Automatically give the arriving file a unique name (default).
  802.     OVERWITE = Overwrite the existing file with the new file.
  803.     DISCARD  = Reject any file that has the same name as an existing file.
  804.  
  805. SET FILE CHARACTER-SET { CP437, CP850, CP860, CP863, CP865, CP866 }
  806.   Tell Kermit which IBM PC code page to use when sending or receiving a
  807.   text file.  Default is your current PC code page.  Kermit translates between
  808.   the current file character set and the transfer character set.
  809.  
  810. SET TRANSFER CHARACTER-SET { TRANSPARENT, LATIN1, CYRILLIC } = TRANSPARENT
  811.   Tell Kermit the character set used in Kermit packets.  TRANSPARENT means no
  812.   translation.  LATIN1 is ISO Latin Alphabet 1, useful for transferring text
  813.   that contains accented characters with other Kermit programs that support
  814.   this feature.  CYRILLIC is ISO 8859-5 Latin/ Cyrillic, and can be used only
  815.   with file character-set CP866.
  816.  
  817. SET UNKNOWN-CHARACTER-SET { DISCARD, KEEP } = KEEP
  818.   What to do when a file arrives that has an unknown character set.
  819.  
  820. SET FILE WARNING { ON, OFF, NO-SUPERSEDE } = ON
  821.   Obsolete synomym for SET FILE COLLISION.
  822.  
  823. SET INCOMPLETE { KEEP, DISCARD } = DISCARD
  824.   What to do with a file that does not arrive completely.
  825.  
  826. SET RETRY <number> = 5
  827.   How many times to retry a particular packet before giving up on the file.
  828.  
  829. SET TIMER { ON, OFF } = ON
  830.   Enable/Disable timeouts and retransmissions during file transfer.
  831.  
  832. SET WINDOW <num> = 1
  833.   Number of sliding window packet slots.  Sizes greater than 1 can be used
  834.   only with other Kermit programs that supports sliding windows.  Improves
  835.   transmission efficiency on long-delay or noisy connections.
  836.  
  837. SET SEND (or RECEIVE) <parameter> <value>
  838.   START-OF-PACKET <num> = 1  packet begin character, normally Ctrl-A
  839.   END-OF-PACKET <num> = 13   packet end character, normally carriage return
  840.   PACKET-LENGTH <num> = 94   packet length; 2000 max; > 94 for "long packets"
  841.   PAUSE <num> = 0            Interpacket pause, milliseconds
  842.   TIMEOUT <num> = 5          Timeout interval waiting for a packet, seconds
  843.   PADDING <num> = 0          How many padding characters before each packet
  844.   PADCHAR <num> = 0          Padding character to use
  845.   DOUBLE-CHAR <num>          Double packet character <char> when sending.
  846.   IGNORE-CHAR <num>          Discard <char> from packets when receiving.
  847.  
  848. Use SHOW FILE, SHOW PROTOCOL to examine current file transfer settings.
  849.  
  850. * COMMANDS FOR FILE TRANSFER WITHOUT ERROR CHECKING
  851.  
  852. Kermit can also transfer files or other information with remote computers,
  853. services, or devices that do not support the Kermit file transfer protocol.
  854. These methods provide no error detection or correction.  Use with caution.
  855.  
  856. TRANSMIT <filename>
  857.   Send a text file to the host as if you were typing it at the keyboard
  858.   a line at a time.  Waits for linefeed (\10) to echo before sending next
  859.   line.  Uses all current communication settings (parity, flow, etc).
  860.   Does'nt translate character sets.  CRLF is sent as CR only unless SET
  861.   TRANSMIT LINE-FEEDS ON.  Empty lines are sent as pairs of CRs (or CRLFS)
  862.   unless SET TRANSMIT FILL is used.
  863.  
  864. SET TRANSMIT <parameter> <value>
  865.   Various parameters used to control TRANSMIT command.
  866.   FILL-EMPTY-LINE { NONE, SPACE, <char> }
  867.   LINE-FEEDS-SENT { ON, OFF }
  868.   PROMPT <char> - character to wait for before sending next line (= \10)
  869.  
  870. LOG SESSION <filename>
  871.   Capture a remote file, which you must TYPE, into the named file
  872.   (SESSION.LOG by default).  Use \Klogoff and \Klogon keyboard verbs to
  873.   stop and restart logging (Ctrl-]Q, Ctrl-]R).
  874.  
  875. CLOSE SESSION
  876.   Stop capturing and close the session log file.
  877.  
  878. * COMMANDS FOR RECORDING THINGS
  879.  
  880. LOG TRANSACTION [<filename>] = TRANSACT.LOG
  881.   Log file transfer names, times, etc, in given file.
  882.  
  883. LOG SESSION [<filename>] = SESSION.LOG
  884.   Record terminal session in given file.
  885.   Use REPLAY <filespec> to view the log.
  886.  
  887. LOG PACKETS [<filename>] = PACKET.LOG
  888.   Record file transfer packets in given file.
  889.  
  890. WRITE {FILE, PACKET, SESSION, TRANSACTION, SCREEN} [<text>]
  891.   Write the text to the specified log file or to the screen.  Text may contain
  892.   backslash codes, variables, etc.  Kermit does not supply line terminators
  893.   so include \13\10 at the end of the text if you want the text to end in CRLF.
  894.  
  895. CLOSE {PACKET, SESSION, TRANSACTION, READ, WRITE, ALL}
  896.   Close the specified log file and stop logging.
  897.  
  898. SHOW LOG
  899.   Display names and status of logging and log files.
  900.  
  901. Ctrl-]F (while in Connect mode)
  902.   Dump current text screen into a file (even if graphics screen is showing).
  903.  
  904. Ctrl-End (while in Connect mode)
  905.   Dump the current screen (text or graphics) into a file.
  906.  
  907. SET DUMP <name>
  908.   Specify name of screen dump file for text screens (KERMIT.SCN by default).
  909.   Graphics screens are saved to TEKPLTnn.TIF.
  910.  
  911. * MACROS
  912.  
  913. DEFINE <macro-or-variable-name> [<text>]
  914.   Defines a macro or variable called "<name>" to have the given value.  If
  915.   <text> is omitted, undefines the named macro or variable.  When defining
  916.   command macros, <text> should be a list of MS-DOS Kermit commands, separated
  917.   by commas.  This command can also be used to define a variable like \%1, \%a,
  918.   etc.  The definition is copied literally (backslash codes not interpreted).
  919.  
  920. [DO] <macro-name> [<parameter1> [<parameter2> [<parameter3> [...]]]]
  921.   Executes the macro called "<name>", and assigns the parameters, if any, to
  922.   the variables \%1, \%2, \%3, etc, and sets the variable ARGC to the number of
  923.   parameters plus one (1 = no parameters, 2 = 1 parameter, etc).  The variable
  924.   \%0 is assigned the name of the macro.  These variables are available only
  925.   within the macro.
  926.  
  927. ASSIGN <macro-or-variable-name> [<text>]
  928.   Like DEFINE, copies the current value of <text> into the macro or variable,
  929.   but (unlike DEFINE) all variables in the <text> are evaluated first.
  930.  
  931. SHOW MACRO [<name>]
  932.   Shows the definition of the specified macro or variable.
  933.  
  934. IF DEFINED <name> <command>
  935.   Executes the <command> if the macro or variable name is defined.
  936.  
  937. IF = ARGC <num> <command>
  938.   Executes <command> if ARGC is equal to <num> (numeric constant or variable)
  939.  
  940. IF < ARGC <num> <command>
  941.   Executes <command> if ARGC is less than <num>
  942.  
  943. IF > ARGC <num> <command>
  944.   Executes <command> if ARGC greater than <num>
  945.  
  946. IF NOT > ARGC <num> <command>
  947.   Executes <command> if ARGC less than or equal to <num>
  948.  
  949. IF =, <, >
  950.   Can also be used with any numeric variables or constants, not just ARGC,
  951.   including the other predefined numeric variables, VERSION, COUNT, and
  952.   ERRORLEVEL, the built-in numeric variables like \v(ndate), \v(status), etc,
  953.   or any other variable (\%1, \%a) that has a numeric value.  Use IF EQUAL to
  954.   compare character strings (see below).
  955.  
  956. * VARIABLES
  957.  
  958. \%0 is the name of the currently executing macro (if any).  \%1 thru \%9 are
  959. its parameters (arguments), created when the macro is invoked and destroyed
  960. when it terminates.  If a macro invokes another macro, a new set of arguments
  961. is created and the old set is preserved.  (This is a change from 3.01 and
  962. earlier, in which macro arguments were global.)
  963.  
  964. \%a through \%z are global variables that can be modified or accessed in any
  965. context.  Created by DEFINE, ASSIGN, ASK, ASKQ, or READ.
  966.  
  967. Macro definitions can be used as variables too.  DEFINE or ASSIGN the macro in
  968. the normal way, but refer to it using \m(name), for example:
  969.  
  970.    define phone-number 7654321
  971.    if not defined phone-number echo Phone number is is not defined!
  972.    echo The phone number is \m(phone-number).
  973.    dial \m(phone-number)
  974.  
  975. \v(xxx) is a built-in variable, where xxx is its name:
  976.    \v(argc)        macro argument count
  977.    \v(count)       current value of loop counter (SET COUNT / IF COUNT)
  978.    \v(date)        current date in country format, e.g. dd-mm-yyyy 08-02-1991
  979.    \v(ndate)       numeric date yyyymmdd, e.g. 19910208
  980.    \v(directory)   current disk and directory, e.g. C:\LETTERS
  981.    \v(errorlevel)  current value of ERRORLEVEL variable (SET ERRORLEVEL)
  982.    \v(keyboard)    IBM PC keyboard type: 88, 101, or (for LK250) 250.
  983.    \v(line)        Same as \v(port)
  984.    \v(platform)    PC type, e.g. IBM-PC, DEC-RAINBOW
  985.    \v(port)        Current SET PORT value
  986.    \v(program)     Program name, MS-DOS_KERMIT
  987.    \v(speed)       Current transmission speed (only for COM1..4, EBIOS)
  988.    \v(status)      0 if previous command succeeded, nonzero if it failed.
  989.    \v(system)      MS-DOS
  990.    \v(time)        Current time of day, hh:mm:ss, e.g. 12:30:01
  991.    \v(version)     Numeric program version, e.g. 311 for version 3.11.
  992.  
  993. \$(xxx) is a DOS environment variable, e.g. \$(COMSPEC).
  994.  
  995. * SCRIPT COMMANDS
  996.  
  997. These commands are used (in conjunction with other Kermit commands) for
  998. carrying out an automated dialog with a remote computer.
  999.  
  1000. ASK <variable> <prompt>
  1001.   Print the <prompt> on the screen, assign what user types to the <variable>.
  1002.  
  1003. ASKQ <variable> <prompt>
  1004.   Like ASK, but do not echo what user types.
  1005.  
  1006. INPUT [<timeout>] <string>
  1007.   Wait up to <timeout> secs for <string> to arrive at communications port.
  1008.   If it arrives, set SUCCESS.  If not, time out and set FAILURE.
  1009.   String may contain backslash codes.
  1010.  
  1011. OUTPUT <string>
  1012.   Send the <string> out the communications port.
  1013.  
  1014. SET INPUT CASE { IGNORE, OBSERVE } = IGNORE
  1015.   Say whether alphabet case should matter in searching for INPUT string.
  1016.  
  1017. SET INPUT DEFAULT-TIMEOUT <secs> = 1
  1018.   Timeout interval to use if none given in INPUT command.
  1019.  
  1020. SET INPUT ECHO { ON, OFF } = ON
  1021.   Whether to display characters read by INPUT command on the screen.
  1022.  
  1023. SET INPUT TIMEOUT-ACTION { PROCEED, QUIT } = PROCEED
  1024.   PROCEED means set SUCCESS or FAILURE and go on to next statement in macro
  1025.   definition or TAKE file.  QUIT means to quit from current macro or TAKE
  1026.   file immediately upon timeout (i.e. upon failure).
  1027.  
  1028. IF SUCCESS <command>
  1029.   Execute the <command> if the preceding INPUT command succeeded.  Also works
  1030.   with file transfer commands like SEND, RECEIVE, GET, BYE, etc.
  1031.  
  1032. IF FAILURE <command>
  1033.   Execute the <command> if the preceding INPUT or file transfer command failed.
  1034.  
  1035. PAUSE <secs>
  1036.   Do nothing for specified number of seconds, or until any character is typed
  1037.   at the keyboard.
  1038.  
  1039. WAIT [<timeout>] [DTR] [CD] [CTS]
  1040.   Wait <timeout> (seconds or until time hh:mm:ss) for specified modem signals.
  1041.  
  1042. CLEAR
  1043.   Clear communications port input buffer.
  1044.  
  1045. STOP
  1046.   Return from macro or TAKE file to the MS-Kermit> prompt.
  1047.  
  1048. END [ number ]
  1049.   Return from current macro or TAKE file to the macro, TAKE file which
  1050.   invoked it, or if none, to the MS-Kermit> prompt.  If the optional number
  1051.   is given, set SUCCESS if the number is 0, set FAILURE if it is nonzero.
  1052.   Synonym: POP.
  1053.  
  1054. GOTO <label>
  1055.   Instead of executing the next statement in the current macro definition or
  1056.   TAKE-file, go to the specified label and begin executing there.  The label
  1057.   must be a word that begins with a colon (:) in the left margin in a macro
  1058.   definition or TAKE file.  If it is not found, Kermit "POPs" one level and
  1059.   looks there, and so on through all active macros and command files.
  1060.  
  1061. :LOOP
  1062.   The previous line shows a label called "loop".  GOTO LOOP would find it.
  1063.  
  1064. REINPUT <timeout> <string>
  1065.   Like INPUT, but instead of waiting for <string> to arrive at communications
  1066.   port, REINPUT rescans the text that has already arrived.
  1067.  
  1068. SET COUNT <number>
  1069.   Sets the loop counter to <number>.
  1070.  
  1071. IF COUNT <command>
  1072.   Subtract one from count.  If result is greater than 0, execute <command>.
  1073.   Use with GOTO to construct counted loops.
  1074.  
  1075. SET ALARM <time>
  1076.   Set an alarm <time> seconds from now, or at time hh:mm:ss.
  1077.  
  1078. IF ALARM <command>
  1079.   If the alarm time has passed, execute the <command>.
  1080.  
  1081. SET ERRORLEVEL <number>
  1082.   Set errorlevel to be returned to DOS by Kermit upon exit.
  1083.  
  1084. IF ERRORLEVEL <number> <command>
  1085.   If ERRORLEVEL of most recently executed DOS command matches or exceeds
  1086.   <number>, execute the <command>.
  1087.  
  1088. IF EXIST <filename> <command>
  1089.   If the named file exists, execute the <command>.
  1090.  
  1091. IF EQUAL <word1> <word2> <command>
  1092.   Execute the command if the two words are the same.  The words may be text or
  1093.   variables.
  1094.  
  1095. IF LGT <word1> <word2> <command>
  1096. IF LLT <word1> <word2> <command>
  1097.   Execute the command if <word1> is lexically greater than (LGT) or lexically
  1098.   less than (LLT) <word2>.  EQUAL, LGT, and LLT are alphabetical comparisons.
  1099.   Case is treated according to SET INPUT CASE.  To compare text items that
  1100.   contain spaces, use { brackets } for grouping:
  1101.     IF LLT {\%a} {more than one word} <command>
  1102.  
  1103. OPEN {READ, WRITE, APPEND} <filename>
  1104.   Open a DOS file in the given mode.
  1105.  
  1106. READ <variable-name>
  1107.   Read a line from the current OPEN READ file into the given variable,
  1108.   discarding line terminators.  Sets FAILURE flag at end of file.
  1109.  
  1110. WRITE FILE <text>
  1111.   Write the text into the current OPEN WRITE or OPEN APPEND file; <text> can
  1112.   contain any mixture of ordinary characters, backslash codes, variable names.
  1113.  
  1114. CLOSE {READ, WRITE}
  1115.   Close the current READ or WRITE (including APPEND) file.
  1116.  
  1117. * TCP/IP NETWORK SETUP
  1118.  
  1119. This section assumes knowledge of TCP/IP.  See "Using MS-DOS Kermit" for
  1120. additional explanatory material, or Douglas Comer's book "Internetworking with
  1121. TCP/IP" (Prentice-Hall), or show this material to your network manager.
  1122.  
  1123. To use Kermit's built-in TCP/IP support, you need a network adapter, an
  1124. Ethernet-style packet driver (not device driver) for the adapter, and a
  1125. connection to a TCP/IP network or a network that is gatewayed to one.
  1126.  
  1127. Install an Ethernet-style packet driver for your PC's network interface.  If
  1128. your network interface vendor did not supply you with a packet driver, they
  1129. are available via anonymous FTP from Clarkson College in Potsdam, NY, host
  1130. sun.soe.clarkson.edu [128.153.12.3], cd pub/ka9q, use "type binary", get the
  1131. appropriate zip, arc, zoo, etc, files, and use PKUNZIP, PKXARC, or ZOO on your
  1132. PC to unpack them, read the files READ.ME, MANIFEST.DOC, and INSTALL.DOC, and
  1133. take it from there.
  1134.  
  1135. Before Kermit can use the TCP/IP network, you must use SET TCP/IP commands to
  1136. supply Kermit with the necessary details about it.  Check with your network
  1137. manager to find out the correct values for these commands, and then put them
  1138. in your MSKERMIT.INI file.  Don't make them up!
  1139.  
  1140. You can view your TCP/IP settings with the SHOW COMMUNICATIONS command.
  1141.  
  1142. SET TCP/IP ADDRESS <IP-address or BOOTP or RARP>
  1143.   Tell Kermit your PC's IP address (required).  If your local network has a
  1144.   BOOTP or RARP server, you can SET TCP/IP ADDRESS BOOTP or RARP to have the
  1145.   server download your IP address automatically.  Examples:
  1146.     SET TCP/IP ADDRESS 128.59.77.23 ; My IP address, fully specified
  1147.     SET TCP/IP ADDRESS BOOTP        ; Get my address from a BOOTP server
  1148.     SET TCP/IP ADDRESS RARP         ; Get my address from a RARP server
  1149.  
  1150. SET TCP/IP SUBNETMASK <IP-address-mask>
  1151.   Tell Kermit which portion of an IP address corresponds to your physical
  1152.   network.  The default is 255.255.255.0.  A correct value is essential; it is
  1153.   used by Kermit to tell whether an IP address is on your physical network
  1154.   or must be accessed through a gateway.  Incorrect values prevent successful
  1155.   communication.  The subnetmask can be downloaded by BOOTP.
  1156.  
  1157. SET TCP/IP BROADCAST <IP-broadcast-address>
  1158.   Tell Kermit the IP address to use when sending IP broadcast messages, for
  1159.   example to the BOOTP server, and to recognize incoming ones.  The default is
  1160.   255.255.255.255, meaning " my own physical network".  Change this parameter
  1161.   if your BOOTP server is on a different subnet of your local network, or if
  1162.   your local network uses the old 4.2 Berkeley UNIX convention of 0's rather
  1163.   than 1's for IP broadcast addresses.  An incorrect value can prevent
  1164.   successful communication, or worse.
  1165.  
  1166. SET TCP/IP PRIMARY-NAMESERVER <IP-address>
  1167.   The IP address of your network's primary nameserver, which translates
  1168.   hostnames into IP addresses.  Required if you want to use host names rather
  1169.   than numeric IP addresses in your SET PORT TCP/IP commands.  Example:
  1170.     SET TCP/IP PRIMARY-NAMESERVER 128.59.77.1
  1171.   Can also be downloaded automatically by BOOTP.
  1172.  
  1173. SET TCP/IP SECONDARY-NAMESERVER <IP-address>
  1174.   The IP address of your network's secondary nameserver, used by Kermit if the
  1175.   primary nameserver is unavailable.  If no nameserver is reachable, use IP
  1176.   host numbers rather than names in your SET PORT TCP/IP commands.  Nameserver
  1177.   addresses can also be downloaded automatically by BOOTP.
  1178.  
  1179. SET TCP/IP GATEWAY <IP-address>
  1180.   The IP address of the gateway between your local area network and the rest of
  1181.   the Internet.  Required if you want to communicate outside of your immediate
  1182.   local network.  Can also be downloaded automatically by BOOTP.
  1183.  
  1184. SET TCP/IP HOST <IP-address or hostname>
  1185.   The default host for SET PORT TCP/IP commands.  SET PORT TCP/IP <host> sets
  1186.   this too, so the next SET PORT TCP/IP command remembers it if you omit the
  1187.   host.  This allows you to switch back and forth between serial and TCP/IP
  1188.   connections.
  1189.  
  1190. SET TCP/IP DOMAIN <domain-name>
  1191.   IP domain name for your organization or department, for example columbia.edu
  1192.   for Columbia University, cc.columbia.edu for the Computer Center at Columbia
  1193.   University.  This lets you refer to hosts on your local network with
  1194.   nicknames, for example watsun rather than watsun.cc.columbia.edu.  When a
  1195.   hostname given in your SET PORT TCP/IP command can't be found, Kermit appends
  1196.   the domain and tries again.  If it still can't be found, Kermit trims the
  1197.   leftmost field from the domain and tries again, and so on until the host is
  1198.   found or the domain name is used up:
  1199.     SET TCP/IP DOMAIN cc.columbia.edu
  1200.     SET PORT TCP/IP oofa.cs
  1201.   Kermit tries (in this order): oofa.cs, oofa.cs.cc.columbia.edu,
  1202.   oofa.cs.columbia.edu, oofa.cs.edu.
  1203.  
  1204. Sample TCP-related commands for MSKERMIT.INI (substitute your own correct
  1205. values for the ones shown here!):
  1206.  
  1207.   SET TCP/IP ADDRESS 128.59.77.23              ; Your PC's IP address
  1208.   SET TCP/IP SUBNETMASK 255.255.255.0          ; Your local net's subnet mask
  1209.   SET TCP/IP GATEWAY 128.59.77.1               ; The gateway on your local net
  1210.   SET TCP/IP PRIMARY-NAMESERVER 128.59.77.19   ; Nameserver on your local net
  1211.   SET TCP/IP SECONDARY-NAMESERVER 128.59.78.12 ; Fallback nameserver
  1212.   SET TCP/IP DOMAIN bar.baz.edu                ; Your local IP domain name
  1213.  
  1214. Then, to make a TCP/IP connection:
  1215.  
  1216.   SET PORT TCP/IP foo                          ; Connect to foo.bar.baz.edu
  1217.   CONNECT
  1218.  
  1219. The TCP/IP connection is not actually established until the CONNECT (or INPUT
  1220. or OUTPUT or similar) command is given, at which time some progress messages
  1221. are displayed on your screen.  If connection is immediate, you won't see these
  1222. messages, but if the connection fails, they will remain visible so you'll know
  1223. why it failed.
  1224.  
  1225. Logging out from the remote host will normally terminate your session and
  1226. pop you back to the MS-Kermit> prompt.  The HANGUP command, or Ctrl-]H during
  1227. terminal emulation, should do the same thing.
  1228.  
  1229. If your network has a BOOTP server, Kermit can learn its own IP address, as
  1230. well as the nameserver addresses, gateway address, and subnet mask from the
  1231. server if the BOOTP server's database has an entry for your PC that contains
  1232. these items.  Then, only commands you need to set up your TCP connection are:
  1233.  
  1234.   SET TCP/IP SUBNETMASK 255.255.254.0 ; Subnet mask
  1235.   SET TCP/IP DOMAIN bar.baz.edu       ; Your local IP domain name
  1236.   SET TCP/IP ADDRESS BOOTP            ; Get other info via BOOTP
  1237.  
  1238.   SET PORT TCP/IP <name-or-number>    ; Establish a connection
  1239.   CONNECT
  1240.  
  1241. The SET TCP/IP SUBNETMASK command is necessary only if your subnetwork uses
  1242. a different mask than Kermit's default, which is 255.255.255.0.
  1243.  
  1244. The first group of commands can go into your MSKERMIT.INI file.  Since they are
  1245. not specific to your PC, they can also go into everyone else's initialization
  1246. file who has a PC on the same network, provided each PC is in the BOOTP
  1247. database.  Kermit sends an IP broadcast message to find the BOOTP server.  If
  1248. you also have given SET TCP/IP ADDRESS, SUBNETMASK, PRIMARY-NAMESERVER,
  1249. SECONDARY-NAMESERVER, and GATEWAY commands, their values will be superseded by
  1250. any values sent by the BOOTP server.
  1251.  
  1252. BOOTP service has the great advantage that PC network configurations need be
  1253. maintained in only one central file, rather than on many individual PCs.  If
  1254. the BOOTP server is unavailable, users can still enter the required information
  1255. with SET TCP/IP commands.  A BOOTP server for Berkeley UNIX is available by
  1256. anonymous FTP from lancaster.andrew.cmu.edu [128.2.13.21] in pub/bootp.?.?.tar
  1257. (or .tar.Z), where ?.? is the current bootp release number, such as 2.1.
  1258.  
  1259. If your network has a RARP server, Kermit can learn its own IP address from the
  1260. server, if the RARP server's database contains an entry for your PC.  The RARP
  1261. server can't tell you the subnetmask, nameserver addresses, or gateway address,
  1262. so you will still need these items in your MSKERMIT.INI file.  However,
  1263. everybody on the same physical network can use the same TCP/IP network
  1264. parameters in their MSKERMIT.INI files because the SET TCP/IP parameters other
  1265. than ADDRESS are all the same.
  1266.  
  1267. HINT: To avoid typing long SET PORT TCP/IP commands, define a macro for each
  1268. host you commonly connect to:
  1269.  
  1270.   DEFINE OOFA SET PORT TCP/IP OOFA, CONNECT
  1271.  
  1272. Put these definitions in your MSKERMIT.INI file.  Then just type "OOFA" to
  1273. connect to TCP/IP host OOFA.
  1274.  
  1275. (End of MS-DOS Kermit 3.11 Help File)
  1276.